Merge remote-tracking branch 'upstream/ignition-8.3' into ignition-8.3

jvanhill · jvanhill · commit 72d21e91518e · 2025-09-25T17:25:56.000-05:00
diff --git a/README.md b/README.md
@@ -5,9 +5,6 @@
 ### Gradle Examples
 
 ##### [Perspective Component](perspective-component)
-> [!WARNING]
-> Additional work on Ignition is required before all components in this example will work as expected.
-
 Adds component to the Perspective module's set of components, demonstrating use of various APIs in a build automation which represents one possible solution for 'production' toolchains.
 
 ##### [Perspective Minimal Component](perspective-component-minimal)
diff --git a/perspective-component-minimal/gradle/libs.versions.toml b/perspective-component-minimal/gradle/libs.versions.toml
@@ -1,5 +1,5 @@
 [versions]
-    ignition = "8.3.0-SNAPSHOT"
+    ignition = "8.3.0-beta2"
 
 [libraries]
     # Dependencies provided by the Ignition SDK, they all reference the 'ignition' version
diff --git a/perspective-component/README.md b/perspective-component/README.md
@@ -1,7 +1,4 @@
 # Perspective Component Module Example
-> [!WARNING]
-> Additional work on Ignition is required before all components in this example will work as expected.
-
 This is an example module which adds some custom components to the Perspective module.  There are 3 different components
 in this example, each exercising different aspects of the Perspective component API, as well as demonstrating
 a few different ways of dealing with data and configuration of the components in the gateway designer.
@@ -31,20 +28,20 @@ Ultimately it's up to implementors to choose the tools they prefer.
 
 ## Quick Tool Overview
 
-This project uses a number of build tools in order to complete the various parts of its assembly.  It's importatnt to note that these tools are just some example options.  You may use any tool you want (or no tool at all).  These examples use:
+This project uses a number of build tools in order to complete the various parts of its assembly.  It's important to note that these tools are just some example options.  You may use any tool you want (or no tool at all).  These examples use:
 
-* [Gradle](https://gradle.org/) - the primary build tool. Most tasks executed in a typical workflow are gradle tasks.
-* [lerna.js](https://lernajs.io/) - is a javascript build-orchestration tool.  It allows us to have independent 'modules'
+* [Gradle](https://gradle.org/) — the primary build tool. Most tasks executed in a typical workflow are gradle tasks.
+* [lerna.js](https://lernajs.io/) — is a javascript build-orchestration tool.  It allows us to have independent 'modules'
  and 'packages' in the same git/hg repository without having to do a lot of complicated symlinking/publishing to pull in changes from one project to another.  It's mostly useful from the commandline, outside of gradle.
-* [yarn](https://yarnpkg.com/) - is a javascript dependency (package) manager that provides a number of improvements
+* [yarn](https://yarnpkg.com/) — is a javascript dependency (package) manager that provides a number of improvements
 over npm, though it shares much of the same commands and api.  Much like Ivy or Maven, yarn is used to resolve and download dependencies hosted on remotely hosted repositories.  Inductive Automation publishes our own dependencies through the
  same nexus repository system we use for other sdk artifacts.  To correctly resolve the Inductive Automation node packages,
   an `.npmrc` file needs to be added to the front end projects to tell yarn/npm where to find packages in the `@inductiveautomation` namespace.  You will find examples of these in the `web/` directory.
-* [Typescript](https://www.typescriptlang.org/) - the language used to write the front end parts.  Typescript is not required, but is strongly recommended.  Typescript can be thought of as modern javascript with types added (though this is a simplification). The addition of types to JS results in a far better developer experience through much better tooling
+* [Typescript](https://www.typescriptlang.org/) — the language used to write the front end parts.  Typescript is not required, but is strongly recommended.  Typescript can be thought of as modern javascript with types added (though this is a simplification). The addition of types to JS results in a far better developer experience through much better tooling
   support.  This can improve maintainability, refactoring, code navigation, bug discovery, etc.  Typescript has its own compiler which emits javascript.  This compiler is frequently paired with other build tools in a way that it emits the javascript, but
   other tools handle the actual bundling of assets, css, and other supporting dependencies.  Think of typescript as the
   java compiler without jars or resources.  It just takes typescript files in, and emits the javascript files.
-* [Webpack](https://webpack.js.org/) - the 'bundler' that we use to take the javascript emitted by the typescript compiler and turn it into an actual package that includes necessary assets, dependencies, generates sourcemaps, etc.
+* [Webpack](https://webpack.js.org/) — the 'bundler' that we use to take the javascript emitted by the typescript compiler and turn it into an actual package that includes necessary assets, dependencies, generates sourcemaps, etc.
 
 
 More documentation incoming, and the web/README.md contains a lot of information about the typescript build process.
@@ -71,13 +68,13 @@ gradlew build
 ```
 
 If you would like to be able to execute parts of the build without depending on gradle, you'll need familiarity with
-the javascript and typescript ecosystem, including NodeJs, NPM/Yarn, Typescript, Webpack, Babel, etc.
+the javascript and typescript ecosystem, including Node.js, NPM/Yarn, Typescript, Webpack, Babel, etc.
 
 While not a comprehensive instruction set, the process of setting up these tools would look something like the following:
 
-1. Install node and npm, which can be used to further install yarn, typescript, webpack, etc.  MacOs and Linux can
+1. Install node and npm, which can be used to further install yarn, typescript, webpack, etc.  macOS and Linux can
 install via package managers, or they and Windows can be installed via the downloads at the
-[NodeJS Website](https://nodejs.org/).   We recommend sticking with the LTS versions (actual versions used by the build)
+[Node.js Website](https://nodejs.org/).   We recommend sticking with the LTS versions (actual versions used by the build)
 can be seen in the `./web/build.gradle` file, within the `node` configuration block.
 
 2. With npm installed, install the global dev-dependency tools.  While it's possible to make gradle handle all these,
@@ -104,7 +101,7 @@ This section provides a high-level overview of the different parts of this proje
 the `web` subproject, see the readme there.
 
 This example module has a fairly traditional Ignition Module project layout with one key difference.  Like most cross-scope projects, this one has a `common` subproject which is  shared between gateway and designer scopes.  What it does NOT
-have is a `client` scope.  Instead we have a `web` subproject which contains the source code, assets, and build
+have is a `client` scope.  Instead, we have a `web` subproject which contains the source code, assets, and build
 configuration used to build the html/js/css used in the module.
 
 Within the `web` directory is a _lerna workspace_, which is simply a javascript corollary to a 'maven multi-module
diff --git a/perspective-component/gateway/src/main/java/org/fakester/gateway/endpoint/DataEndpoints.java b/perspective-component/gateway/src/main/java/org/fakester/gateway/endpoint/DataEndpoints.java
@@ -1,5 +1,6 @@
 package org.fakester.gateway.endpoint;
 
+import java.util.EnumSet;
 import java.util.List;
 import java.util.Objects;
 import java.util.concurrent.atomic.AtomicReference;
@@ -12,6 +13,8 @@
 import com.inductiveautomation.ignition.gateway.dataroutes.RouteGroup;
 import com.inductiveautomation.ignition.gateway.model.GatewayContext;
 import com.inductiveautomation.ignition.gateway.tags.model.GatewayTagManager;
+import com.inductiveautomation.perspective.gateway.api.SessionScope;
+import com.inductiveautomation.perspective.gateway.comm.Routes;
 import jakarta.servlet.http.HttpServletResponse;
 
 
@@ -33,6 +36,7 @@ public static void mountRoutes(RouteGroup routes) {
         routes.newRoute("/component/tagcount")
             .type(RouteGroup.TYPE_JSON)
             .handler(DataEndpoints::fetchTagCount)
+            .accessControl(Routes.requireSession(EnumSet.of(SessionScope.Client, SessionScope.Designer)))
             .mount();
     }
 
diff --git a/perspective-component/gradle/libs.versions.toml b/perspective-component/gradle/libs.versions.toml
@@ -1,5 +1,5 @@
 [versions]
-    ignition = "8.3.0-SNAPSHOT"
+    ignition = "8.3.0-beta2"
 
 [libraries]
     # Dependencies provided by the Ignition SDK, they all reference the 'ignition' version
diff --git a/perspective-component/web/packages/client/typescript/components/TagCounter.tsx b/perspective-component/web/packages/client/typescript/components/TagCounter.tsx
@@ -27,7 +27,7 @@ interface TagCountProps {
 }
 
 const HOST = `${location.protocol}//${location.host}`;
-const COUNT_FETCH_URL = `${HOST}/main/data/radcomponents/component/tagcount`;
+const COUNT_FETCH_URL = `${HOST}/data/radcomponents/component/tagcount`;
 
 interface TagCounterState {
     tagCount: number;
diff --git a/secret-provider/README.md b/secret-provider/README.md
@@ -1,6 +1,6 @@
 # Secret Provider
 
-This module provides an example implementation of the `SecretProvider` interface, which allows for the user of stored 
+This module provides an example implementation of the `SecretProvider` interface, which allows for the use of stored 
 secrets by Ignition. It is backed by a MongoDB backend, and the secrets are expected to be stored in the MongoDB 
 database as the JSON returned from `SystemEncryptionService.entryToJson(Plaintext)`.
 
diff --git a/secret-provider/pom.xml b/secret-provider/pom.xml
@@ -7,15 +7,15 @@
     <groupId>com.inductiveautomation.ignition.examples</groupId>
     <artifactId>secret-provider</artifactId>
     <packaging>pom</packaging>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.3.0-SNAPSHOT</version>
 
     <modules>
         <module>secret-provider-build</module>
         <module>secret-provider-gateway</module>
     </modules>
 
     <properties>
-        <ignition-platform-version>8.3.0-beta3</ignition-platform-version>
+        <ignition-platform-version>8.3.0-rc1</ignition-platform-version>
         <ignition-sdk-version>${ignition-platform-version}</ignition-sdk-version>
         <module-name>MongoDB Secret Provider Example</module-name>
         <module-description>Adds a secret provider backed by MongoDB to Ignition.</module-description>
diff --git a/secret-provider/secret-provider-build/pom.xml b/secret-provider/secret-provider-build/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.inductiveautomation.ignition.examples</groupId>
         <artifactId>secret-provider</artifactId>
-        <version>1.0.0-SNAPSHOT</version>
+        <version>1.3.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>secret-provider-build</artifactId>
diff --git a/secret-provider/secret-provider-gateway/pom.xml b/secret-provider/secret-provider-gateway/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.inductiveautomation.ignition.examples</groupId>
         <artifactId>secret-provider</artifactId>
-        <version>1.0.0-SNAPSHOT</version>
+        <version>1.3.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>secret-provider-gateway</artifactId>
diff --git a/secret-provider/secret-provider-gateway/src/main/java/com/inductiveautomation/ignition/examples/secretprovider/mongodb/MongoDbSecretProvider.java b/secret-provider/secret-provider-gateway/src/main/java/com/inductiveautomation/ignition/examples/secretprovider/mongodb/MongoDbSecretProvider.java
@@ -2,6 +2,7 @@
 
 import com.inductiveautomation.ignition.common.gson.JsonElement;
 import com.inductiveautomation.ignition.common.gson.JsonParser;
+import com.inductiveautomation.ignition.common.lifecycle.Lifecycle;
 import com.inductiveautomation.ignition.common.util.LoggerEx;
 import com.inductiveautomation.ignition.gateway.secrets.*;
 import com.mongodb.ConnectionString;
@@ -18,10 +19,25 @@
 import java.util.List;
 import java.util.Objects;
 
-
-public class MongoDbSecretProvider implements SecretProvider {
-
-    private static final LoggerEx LOGGER = LoggerEx.newBuilder().build(MongoDbSecretProvider.class);
+/**
+ * An example implementation of a Secret Provider that uses MongoDB as the backend data store.
+ * <p>
+ * This class demonstrates how to implement the {@link SecretProvider} interface and manage secrets
+ * stored in a MongoDB database. It supports listing secrets and reading individual secrets by name.
+ * <p>
+ * The secrets are stored in a MongoDB collection named "secrets", where each document contains
+ * a "name" field for the secret name and a "ciphertext" field for the encrypted secret value. The encrypted
+ * secret value is stored as a JSON-encoded object, which is decrypted using Ignition's
+ * {@link SystemEncryptionService} when reading the secret. The {@link SystemEncryptionService} should also
+ * be used to populate the document when writing secrets to the database, which must be done externally at this
+ * time.
+ * <p>
+ * The class also implements the {@link Lifecycle} interface, allowing it to manage its own lifecycle
+ * and resources via the startup and shutdown methods. It's an optional interface to implement, so
+ * only do so if you need to manage resources explicitly. In this case, the MongoDB client is created
+ * when the provider is first used and remains open for the lifetime of the provider.
+ */
+public class MongoDbSecretProvider implements SecretProvider, Lifecycle {
 
     // The names of the MongoDB collections used in this example.
     private static final String COLLECTION_SECRETS = "secrets";
@@ -33,13 +49,25 @@ public class MongoDbSecretProvider implements SecretProvider {
     // Instance fields for this class.
     private final SecretProviderContext context;
     private final MongoDbSecretProviderResource settings;
-    private final MongoClient mongoClient;
-    private final MongoDatabase database;
-
+    private MongoClientSettings mongoClientSettings;
+    private MongoClient mongoClient;
+    private MongoDatabase database;
+
+    /**
+     * Constructor for the MongoDbSecretProvider.
+     *
+     * @param context  the {@link SecretProviderContext} encapsulating the contextual information needed for creating
+     *                 new {@link SecretProvider} instances of this type.
+     * @param settings the {@link MongoDbSecretProviderResource} containing the configuration settings for this
+     *                 provider.
+     */
     MongoDbSecretProvider(SecretProviderContext context, MongoDbSecretProviderResource settings) {
         this.context = context;
         this.settings = settings;
+    }
 
+    @Override
+    public void startup() {
         // Create a builder for the MongoDB client settings using the provided connection string.
         MongoClientSettings.Builder builder = MongoClientSettings.builder()
                 .applyConnectionString(new ConnectionString(settings.connectionString()));
@@ -58,39 +86,60 @@ public class MongoDbSecretProvider implements SecretProvider {
             }
         }
 
-        // We don't use a try-with-resources block because we want the client to remain open for the lifetime
-        // of this secret provider. If we were to use this in production, we probably would want to re-evaluate
-        // this decision. This code could possibly lead to resource leaks if not managed properly or issues with
-        // connectivity if the MongoDB instance is restarted or becomes unavailable.
-        mongoClient = MongoClients.create(builder.build());
-        database = mongoClient.getDatabase(settings.databaseName());
+        this.mongoClientSettings = builder.build();
+    }
+
+    @Override
+    public void shutdown() {
+        if (mongoClient != null) {
+            mongoClient.close();
+        }
+    }
+
+    /**
+     * Retrieves the MongoDB database instance for this secret provider.
+     *
+     * @return the {@link MongoDatabase} instance.
+     */
+    private MongoDatabase getDatabase() {
+        if (database == null) {
+            if (mongoClient == null) {
+                // We don't use a try-with-resources block because we want the client to remain open for the lifetime
+                // of this user source profile.
+                mongoClient = MongoClients.create(mongoClientSettings);
+            }
+
+            // Get the database from the MongoDB client using the configured database name.
+            database = mongoClient.getDatabase(settings.databaseName());
+        }
+        return database;
     }
 
     @Override
     public List<String> list() throws SecretProviderException {
-        MongoCollection<Document> collection = database.getCollection(COLLECTION_SECRETS);
+        MongoCollection<Document> collection = getDatabase().getCollection(COLLECTION_SECRETS);
 
         try {
             return collection.find()
                     .map(doc -> doc.getString(KEY_NAME))
                     .into(new java.util.ArrayList<>());
         } catch (Exception e) {
-            LOGGER.error("Failed to list secrets from MongoDB", e);
+            context.getLog().error("Failed to list secrets from MongoDB", e);
             throw new SecretProviderException("Failed to list secrets", e);
         }
     }
 
     @Override
     public Plaintext read(String s) throws SecretProviderException {
         Objects.requireNonNull(s, "Secret name cannot be null");
-        MongoCollection<Document> collection = database.getCollection(COLLECTION_SECRETS);
+        MongoCollection<Document> collection = getDatabase().getCollection(COLLECTION_SECRETS);
 
         // Search for the secret by name.
-        Document doc = null;
+        Document doc;
         try {
             doc = collection.find(new Document(KEY_NAME, s)).first();
         } catch (Exception e) {
-            LOGGER.error("Failed to read secret '" + s + "' from MongoDB", e);
+            context.getLog().error("Failed to read secret '" + s + "' from MongoDB", e);
             throw new SecretProviderException("Failed to read secret", e);
         }
 
@@ -104,7 +153,7 @@ public Plaintext read(String s) throws SecretProviderException {
             JsonElement element = JsonParser.parseString(doc.get(KEY_CIPHERTEXT, Document.class).toJson());
             return context.getGatewayContext().getSystemEncryptionService().decryptFromJson(element);
         } catch (Exception e) {
-            LOGGER.error("Failed to decrypt secret '" + s + "'", e);
+            context.getLog().error("Failed to decrypt secret '" + s + "'", e);
             throw new SecretProviderException("Failed to decrypt secret", e);
         }
     }
diff --git a/slack-alarm-notification/README.md b/slack-alarm-notification/README.md
@@ -1,7 +1,4 @@
 # Slack Alarm Notification Example
-> [!WARNING]
-> This example uses a custom contact type, which is not currently accessible via the UI; it must be added to the user's profile manually (see  [Using The Resource Configuration](#using-the-resource-configuration)). 
-
 ### Overview
 
 Provides a framework for implementing a custom alarm notification system.
@@ -14,9 +11,6 @@ webhook, you can add the webhook as a `SLACK_WEBHOOK` Contact Type under your us
 of the following methods:
 
 #### Using the UI
-> [!WARNING]
-> Currently you cannot add the contact type through this method, use the method outlined in [Using The Resource Configuration](#using-the-resource-configuration) instead.
-
 Login to the Gateway, navigate to "Platform > Security > User Sources > [YOUR_USER_SOURCE]," select "Manage Users"
 under the dropdown next to the User Source you want to use, select your user and then "Edit," and add the "Slack"
 Contact Type where the value is the URL of the webhook.
diff --git a/slack-alarm-notification/slack-notification-gateway/src/main/resources/io/ia/ignition/sdk/examples/slack/SlackNotification.properties b/slack-alarm-notification/slack-notification-gateway/src/main/resources/io/ia/ignition/sdk/examples/slack/SlackNotification.properties
@@ -26,4 +26,4 @@ Category.Audit=Auditing
 AuditProfile.Name=Audit Profile
 AuditProfile.Desc=If an audit profile is selected, events such as phone calls and acknowledgements will be stored to the audit system. Note that alarm acknowledgements are also stored to the alarm journal.
 
-ContactType.Slack=Slack Webhook URL
+ContactType.Slack=Slack
diff --git a/user-source-profile/README.md b/user-source-profile/README.md
@@ -2,7 +2,7 @@
 
 This module provides an implementation of the `UserSourceProvider` interface, which allows for the management of user 
 profiles in a system. It includes methods for creating, updating, and deleting user profiles, as well as retrieving user
-information. It is backed by a MongoDB backend.
+information and authenticating users. It is backed by a MongoDB backend.
 
 In a production environment, you may want to use the MongoDB Connector module, but for simplicity, this module uses the
 MongoDB Java driver directly. This allows for easy testing without the need to add another module to Ignition.
diff --git a/user-source-profile/pom.xml b/user-source-profile/pom.xml
diff --git a/user-source-profile/user-source-build/pom.xml b/user-source-profile/user-source-build/pom.xml
diff --git a/user-source-profile/user-source-gateway/pom.xml b/user-source-profile/user-source-gateway/pom.xml
diff --git a/user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSource.java b/user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSource.java
diff --git a/user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSourceExtensionPoint.java b/user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSourceExtensionPoint.java
diff --git a/user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSourceResource.java b/user-source-profile/user-source-gateway/src/main/java/com/inductiveautomation/ignition/examples/usersource/mongodb/MongoDbUserSourceResource.java
diff --git a/webui-webpage/gateway/src/main/java/org/webui/test/gateway/WebuiWebpageGatewayHook.java b/webui-webpage/gateway/src/main/java/org/webui/test/gateway/WebuiWebpageGatewayHook.java

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ interface TagCountProps {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	const HOST = `${location.protocol}//${location.host}`;
`30`		-const COUNT_FETCH_URL = `${HOST}/main/data/radcomponents/component/tagcount`;
	`30`	+const COUNT_FETCH_URL = `${HOST}/data/radcomponents/component/tagcount`;
`31`	`31`
`32`	`32`	`interface TagCounterState {`
`33`	`33`	`tagCount: number;`