Implement a high-level shadow document interface (#16)

* Implement a high-level shadow document interface

* Add JSON compat

* Fix typo

* Export lock,unlock

* Clean up test

* Add lock/unlock test

* Fix shadow unsubscribe

* Remove debug print

* Add missing exports

* Add missing export

* Clean up docs

* dont run tests in parallel

* Fix concurrency groups

* Fix concurrency groups

* Fix concurrency groups

* debug

* debug

* debug

* Remove serialization for now. Will fix in another PR

* Fix documentation typos

* Document when tasks may wait forever while offline

* Document that tasks may wait forever before issuing a connect

.JuliaFormatter.toml

@@ -1 +1,3 @@
 margin = 120
+remove_extra_newlines = true
+format_docstrings = true

.github/workflows/CI.yml

@@ -1,15 +1,11 @@
 name: CI
+
 on:
-  push:
-    branches:
-      - main
-    tags: ["*"]
   pull_request:
-concurrency:
-  # Skip intermediate builds: always.
-  # Cancel intermediate builds: only if it is a pull request build.
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+permissions:
+  contents: read
+
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -73,23 +69,3 @@ jobs:
           ENDPOINT: ${{ secrets.ENDPOINT }}
           CERT_STRING: ${{ secrets.CERT_STRING }}
           PRI_KEY_STRING: ${{ secrets.PRI_KEY_STRING }}
-
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
-        with:
-          version: "1"
-      - uses: julia-actions/julia-buildpkg@v1
-      - uses: julia-actions/julia-docdeploy@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-      - run: |
-          julia --project=docs -e '
-            using Documenter: DocMeta, doctest
-            using AWSCRT
-            DocMeta.setdocmeta!(AWSCRT, :DocTestSetup, :(using AWSCRT); recursive=true)
-            doctest(AWSCRT)'

.github/workflows/Documenter.yml

@@ -0,0 +1,19 @@
+name: Documenter
+on:
+  push:
+    branches: [main]
+    tags: [v*]
+  pull_request:
+
+jobs:
+  Documenter:
+    permissions:
+      contents: write
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -9,3 +9,5 @@ log.txt
 
 # Built Visual Studio Code Extensions
 *.vsix
+
+.env

Project.toml

@@ -1,17 +1,19 @@
 name = "AWSCRT"
 uuid = "df31ea59-17a4-4ebd-9d69-4f45266dc2c7"
-version = "0.1.2"
+version = "0.1.3"
 
 [deps]
 AWSCRT_jll = "01db5350-6ea1-5d9a-9a47-8a31a394cb9c"
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"
 CountDownLatches = "621fb831-fdad-4fff-93ac-1af7b7ed19e3"
 ForeignCallbacks = "809b5ff2-8730-47bb-8e19-67299d747c44"
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 LibAWSCRT = "df7458b6-5204-493f-a0e7-404b4eb72fac"
 
 [compat]
 CEnum = "0.4"
 CountDownLatches = "2"
 ForeignCallbacks = "0.1"
+JSON = "0.21"
 LibAWSCRT = "0.1"
 julia = "1.9"

src/AWSCRT.jl

@@ -1,13 +1,18 @@
 """
 Environment variables:
-- `AWS_CRT_MEMORY_TRACING`: Set to `0`, `1`, or `2` to enable memory tracing. Default is off. See [`aws_mem_trace_level`](@ref).
-- `AWS_CRT_MEMORY_TRACING_FRAMES_PER_STACK`: Set the number of frames per stack for memory tracing. Default is the AWS library's default.
-- `AWS_CRT_LOG_LEVEL`: Set to `0` through `6` to enable logging. Default is off. See [`aws_log_level`](@ref).
-- `AWS_CRT_LOG_PATH`: Set to the log file path. Must be set if `AWS_CRT_LOG_LEVEL` is set.
+
+  - `AWS_CRT_MEMORY_TRACING`: Set to `0`, `1`, or `2` to enable memory tracing. Default is off. See [`aws_mem_trace_level`](@ref).
+  - `AWS_CRT_MEMORY_TRACING_FRAMES_PER_STACK`: Set the number of frames per stack for memory tracing. Default is the AWS library's default.
+  - `AWS_CRT_LOG_LEVEL`: Set to `0` through `6` to enable logging. Default is off. See [`aws_log_level`](@ref).
+  - `AWS_CRT_LOG_PATH`: Set to the log file path. Must be set if `AWS_CRT_LOG_LEVEL` is set.
+
+Note: all the symbols in this package that begin with underscores are private and are not part of this package's published interface. Please don't use them.
 """
 module AWSCRT
 
-using LibAWSCRT, ForeignCallbacks, CountDownLatches, CEnum
+using LibAWSCRT, ForeignCallbacks, CountDownLatches, CEnum, JSON
+import Base: lock, unlock
+export lock, unlock
 
 const _AWSCRT_ALLOCATOR = Ref{Union{Ptr{aws_allocator},Nothing}}(nothing)
 const _GLOBAL_REFS = Vector{Ref}()
@@ -83,9 +88,10 @@ end
 
 aws_err_string(code = aws_last_error()) = "AWS Error $code: " * Base.unsafe_string(aws_error_debug_str(code))
 
-const advanced_use_note = "Note on advanced use: the internal constructor on this struct has been left at its " * 
-"default so that you can bring your own native data if you need to. However, you are then responsible for the " * 
-"memory management of that data."
+const advanced_use_note =
+    "Note on advanced use: the internal constructor on this struct has been left at its " *
+    "default so that you can bring your own native data if you need to. However, you are then responsible for the " *
+    "memory management of that data."
 
 include("AWSIO.jl")
 export EventLoopGroup
@@ -118,5 +124,14 @@ export publish
 
 include("IOTShadow.jl")
 export ShadowClient
+export OnShadowMessage
+
+include("ShadowFramework.jl")
+export ShadowFramework
+export ShadowDocumentPropertyUpdateCallback
+export ShadowDocumentPreUpdateCallback
+export ShadowDocumentPostUpdateCallback
+export shadow_client
+export publish_current_state
 
 end