Merge pull request #159 from splunk/release/1.12.0

Release/1.12.0

Author: fantavlik

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Create Release
 on:
   release:
     types: [published]
-    
+
 jobs:
   publish-npm:
     runs-on: ubuntu-latest
@@ -16,3 +16,18 @@ jobs:
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Package JSON Info
+        uses: myrotvorets/[email protected]
+        id: pkgjson
+
+      - name: Generate docs
+        run: |
+          node sdkdo docs
+          zip -r docs.zip docs/${{ steps.pkgjson.outputs.packageVersion }}/refs
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: apidocs
+          path: docs.zip

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
           - 14
           - 8.17.0
         splunk-version:
-          - "8.0"
+          - "8.2"
           - "latest"
 
     services:

.gitignore

@@ -1,4 +1,4 @@
-*build/
+build/
 .git
 tests/html/*
 *.out
@@ -17,4 +17,5 @@ cover_html
 .splunkrc
 *.zip
 test_logs/*
-docs/
+docs/
+.nyc_output/*

.jshintignore

@@ -5,12 +5,6 @@ node_modules
 build
 client
 external
-examples/browser/create-react-app
-examples/browser/minisplunk
-examples/browser/resources
-examples\\browser\\create-react-app
-examples\\browser\\minisplunk
-examples\\browser\\resources
 old_english
 new_english
 xml2json

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Splunk Enterprise SDK for JavaScript Changelog
 
+## v1.12.0
+
+### New features and APIs
+* SDK Support for splunkd search API changes, for Splunk 9.0+. ([PR#157](https://github.com/splunk/splunk-sdk-javascript/pull/157))
+
+### Minor changes
+* Added assets directory to be included while generating docs ([PR#154](https://github.com/splunk/splunk-sdk-javascript/pull/154))
+* Removed support for Modular Inputs from the SDK ([PR#153](https://github.com/splunk/splunk-sdk-javascript/pull/153))
+* Removed examples and it's references from sdk ([PR#152](https://github.com/splunk/splunk-sdk-javascript/pull/152))
+* Added 'User-Agent' header in REST API calls for the telemetry ([PR#151](https://github.com/splunk/splunk-sdk-javascript/pull/151))
+* changes corresponding to API changes in the dependency library browserify ([PR#149](https://github.com/splunk/splunk-sdk-javascript/pull/149))
+* JS SDK upload artifact script added for api docs ([PR#148](https://github.com/splunk/splunk-sdk-javascript/pull/148))
+
 ## v1.11.0
 
 ### Major changes

Makefile

@@ -45,3 +45,21 @@ wait_up:
 down:
 	@echo "$(ATTN_COLOR)==> down $(NO_COLOR)"
 	@docker-compose stop
+
+.PHONY: deps
+deps:
+	@echo "$(ATTN_COLOR)==> Checking nodes.js dependencies $(NO_COLOR)"
+	@echo "$(ATTN_COLOR)==> Installing nodes.js 14 $(NO_COLOR)"
+	@source $(HOME)/.nvm/nvm.sh ; nvm install 14
+	@echo "$(ATTN_COLOR)==> npm install $(NO_COLOR)"
+	@npm install
+
+.PHONY: clean
+clean:
+	@echo "$(ATTN_COLOR)==> Cleaning client/ directory $(NO_COLOR)"
+	@rm -rf client/splunk.*.js >/dev/null 2>&1
+
+.PHONY: build
+build: clean deps
+	@echo "$(OK_COLOR)==> Initiating the build... $(NO_COLOR)"
+	@source $(HOME)/.nvm/nvm.sh; nvm run 14 sdkdo compile

README.md

@@ -1,7 +1,7 @@
 [![Build Status](https://travis-ci.org/splunk/splunk-sdk-javascript.svg?branch=master)](https://travis-ci.org/splunk/splunk-sdk-javascript)
 # The Splunk Enterprise Software Development Kit for JavaScript
 
-#### Version 1.11.0
+#### Version 1.12.0
 
 The Splunk Enterprise Software Development Kit (SDK) for JavaScript contains library code and examples designed to enable developers to build applications using the Splunk platform and JavaScript. This SDK supports server-side and client-side JavaScript.
 
@@ -13,9 +13,9 @@ For more information, see [Splunk Enterprise SDK for JavaScript](https://dev.spl
 
     The Splunk Enterprise SDK for JavaScript was tested with Node.js v8.17.0, v14. 
 
-* Splunk Enterprise 8.0 or 8.2, or Splunk Cloud
+* Splunk Enterprise 9.0 or 8.2, or Splunk Cloud
 
-    The Splunk Enterprise SDK for JavaScript was tested with Splunk Enterprise 8.0 or 8.2, or Splunk Cloud. 
+    The Splunk Enterprise SDK for JavaScript was tested with Splunk Enterprise 9.0 or 8.2, or Splunk Cloud. 
 
 *  Splunk Enterprise SDK for JavaScript
 
@@ -124,7 +124,7 @@ var serviceWithSessionKey = new splunkjs.Service(
         host: 'localhost',
         port: '8089',
         sessionKey: SESSION_KEY, // Add your sessionKey here
-        version: '8',
+        version: '9.0',
     });
 
 serviceWithSessionKey.get("search/jobs", { count: 1 }, function (err, res) {
@@ -177,14 +177,17 @@ serviceWithBearerToken.get("search/jobs", { count: 2 }, function (err, res) {
 });
 ```
 
+### Modular inputs examples
+Support for modular inputs is removed from Splunk Enterprise SDK for JavaScript and we recommand to use [Splunk Enterprise SDK for Python](https://github.com/splunk/splunk-sdk-python) for the modular inputs. See the [Python SDK modular inputs example](https://github.com/splunk/splunk-app-examples/tree/master/modularinputs/python) and [PythonSDK modular inputs docs](https://dev.splunk.com/enterprise/docs/devtools/python/sdk-python/howtousesplunkpython/howtocreatemodpy) for reference.
+
 ## SDK examples
 
-The Splunk Enterprise SDK for JavaScript contains several server- and client-based examples.
+The Splunk Enterprise SDK for JavaScript contains several server- and client-based examples, which are located in the [Splunk App Example repo](https://github.com/splunk/splunk-app-examples).
 For details, see the [Splunk Enterprise SDK for JavaScript Examples](https://dev.splunk.com/enterprise/docs/devtools/javascript/sdk-javascript/sdkjavascriptexamples) on the Splunk Developer Portal.
 
-#### Create a .splunkrc convenience file
+## Create a .splunkrc convenience file
 
-To connect to Splunk Enterprise, many of the SDK examples and unit tests take command-line arguments that specify values for the host, port, and login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a text file named **.splunkrc**. Then, the SDK examples and unit tests use the values from the **.splunkrc** file when you don't specify them.
+To connect to Splunk Enterprise, many of the SDK unit tests take command-line arguments that specify values for the host, port, and login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a text file named **.splunkrc**. Then, the SDK unit tests use the values from the **.splunkrc** file when you don't specify them.
 
 >**Note**: Storing login credentials in the **.splunkrc** file is only for convenience during development. This file isn't part of the Splunk platform and shouldn't be used for storing user credentials for production. And, if you're at all concerned about the security of your credentials, enter them at the command line rather than saving them in this file.
 
@@ -201,7 +204,7 @@ To use this convenience file, create a text file with the following format:
     # Access scheme (default: https)
     scheme=https
     # Your version of Splunk Enterprise
-    version=8.2
+    version=9.0
 
 Save the file as **.splunkrc** in the current user's home directory.
 
@@ -246,37 +249,6 @@ function (err) {
 });
 ```
 
-### Client-side examples
-
-The Splunk Enterprise SDK for JavaScript includes several browser-based examples, which you can run from the Examples web page.
-
-To start a simple web server and open the Examples page in a web browser, enter:
-
-    node sdkdo examples
-
-### Node.js examples
-
-The Splunk Enterprise SDK for JavaScript includes several command-line examples, which are located in the **/splunk-sdk-javascript/examples/node** directory. These examples run with Node.js and use the command-line arguments from the **.splunkrc** file, if you set this up with your login credentials.
-
-For example, to run the **jobs.js** example, open a command prompt in the **/splunk-sdk-javascript/examples/node** directory and enter:
-
-    node jobs.js list
-
-If you aren't storing your login credentials in **.splunkrc**, enter the following command, providing your own values:
-
-    node jobs.js --username yourusername --password yourpassword list
-
-Your output should look something like this:
-
-    ~\splunk-sdk-javascript\examples\node> node .\jobs.js list
-      Job 1 sid: scheduler__nobody__search_VG9wIGZpdmUgc291cmNldHlwZXM_at_1323917700_79740ae7e22350d6
-      Job 2 sid: scheduler__nobody__search_VG9wIGZpdmUgc291cmNldHlwZXM_at_1323917400_0dceb302931a2b3f
-      Job 3 sid: scheduler__nobody__search_SW5kZXhpbmcgd29ya2xvYWQ_at_1323917100_48fb4cc65a25c5b1
-      Job 4 sid: scheduler__nobody__search_SW5kZXhpbmcgd29ya2xvYWQ_at_1323916200_b2f239fef7834523
-      Job 5 sid: scheduler__nobody__unix_QWxlcnQgLSBzeXNsb2cgZXJyb3JzIGxhc3QgaG91cg_at_1323914400_96cb9084680b25d7
-      Job 6 sid: admin__admin__search_TXkgQXdlc29tZSBTYXZlZCBTZWFyY2g_1323901055.6
-    ==============
-
 ## Development
 
 The Splunk Enterprise SDK for JavaScript infrastructure relies on Node.js to build files, run examples, run tests, and generate documentation. 
@@ -288,6 +260,7 @@ All development activities are managed by a helper script called `sdkdo`. For a
 ### Compile the browser files
 
 To rebuild and minify the browser files, open a command prompt in the **splunk-sdk-javascript** directory and enter:
+Note:- If any TypeError is encountered, please run "npm install" before running the below command.
 
     node sdkdo compile
 
@@ -335,7 +308,6 @@ To get more info to run tests, enter:
 | /client       | Pre-built files for the browser                            |
 | /contrib      | Packaged third-party dependencies (such as test runners)   |
 | /docs         | API reference documentation                                |
-| /examples     | Examples                                                   |
 | /lib          | The SDK code files                                         |
 | /licenses     | License information for packaged third-party dependencies  |
 | /node_modules | JavaScript modules used by Node.js                         |
@@ -360,6 +332,7 @@ To learn about our branching model, see [Branching Model](https://github.com/spl
 | [REST API Reference Manual](https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTprolog) | Splunk REST API reference documentation |
 | [Splunk>Docs](https://docs.splunk.com/Documentation) | General documentation for the Splunk platform |
 | [GitHub Wiki](https://github.com/splunk/splunk-sdk-javascript/wiki/) | Documentation for this SDK's repository on GitHub |
+| [Splunk JavaScript SDK Examples](https://github.com/splunk/splunk-app-examples) | server- and client-based examples for the Splunk JavaScript SDK |
 
 
 ## Community

bin/cli.js

@@ -32,7 +32,6 @@
      * Constants
      */
     var DEFAULT_PORT = 6969;
-    var DOC_DIRECTORY = "docs";
     var REFDOC_DIRECTORY = "refs";
     var CLIENT_DIRECTORY = "client";
     var TEST_DIRECTORY = "tests";
@@ -44,6 +43,10 @@
     var DOC_FILE = "index.html";
     var BUILD_CACHE_FILE = ".buildcache";
     var SDK_VERSION = JSON.parse(fs.readFileSync(path.resolve(__dirname, "../package.json")).toString("utf-8")).version;
+    var DOC_DIRECTORY = "docs-" + SDK_VERSION;
+    var DOC_ASSETS_DIRECTORY = "assets";
+    var DOC_DIRECTORY_ASSETS = path.join("bin/docs", DOC_ASSETS_DIRECTORY);
+    var GENERATED_DOC_ASSETS = path.join(DOC_DIRECTORY, DOC_ASSETS_DIRECTORY);
     var IGNORED_MODULES = [
         "../contrib/nodeunit/test_reporter",
         "../contrib/nodeunit/junit_reporter",
@@ -103,7 +106,8 @@
                     headers: {
                         "Content-Length": req.headers["content-length"] || 0,
                         "Content-Type": req.headers["content-type"] || '',
-                        "Authorization": req.headers["authorization"] || ''
+                        "Authorization": req.headers["authorization"] || '',
+                        "User-Agent": "splunk-sdk-javascript/" + SDK_VERSION
                     },
                     followAllRedirects: true,
                     body: body || '',
@@ -465,38 +469,30 @@
         exportName = exportName || "splunkjs";
 
         // Compile/combine all the files into the package
-        var bundle = browserify({
-            entry: entry,
-            ignore: IGNORED_MODULES,
-            cache: BUILD_CACHE_FILE,
-            filter: function (code) {
-                if (shouldUglify) {
-                    var uglifyjs = require("uglify-js"),
-                        parser = uglifyjs.parser,
-                        uglify = uglifyjs.uglify;
-
-                    var ast = parser.parse(code);
-                    ast = uglify.ast_mangle(ast);
-                    ast = uglify.ast_squeeze(ast);
-                    code = uglify.gen_code(ast);
-                }
-
-                code = [
-                    "(function() {",
-                    "",
-                    "var __exportName = '" + exportName + "';",
-                    "",
-                    code,
-                    "",
-                    "})();"
-                ].join("\n");
-                return code;
+        var bundle = browserify();
+        bundle.add(entry);
+        bundle.ignore(IGNORED_MODULES);
+        bundle.bundle(function (err,src){
+            var code = [
+                            "(function() {",
+                            "",
+                            "var __exportName = '" + exportName + "';",
+                            "",
+                            src.toString(),
+                            "",
+                            "})();"
+                        ].join("\n");
+            if(err){
+                throw err;
+            }
+            if (shouldUglify){
+                var UglifyJS = require("uglify-js");
+                code = UglifyJS.minify({"file1.js":code},{toplevel:true}).code;
             }
+            fs.writeFileSync(path,code);
+            console.log("Compiled " + path);
         });
 
-        var js = bundle.bundle();
-        fs.writeFileSync(path, js);
-        console.log("Compiled " + path);
     };
 
     var outOfDate = function (dependencies, compiled, compiledMin) {
@@ -615,11 +611,6 @@
         launchBrowser("tests/tests.browser.html", port);
     };
 
-    var launchBrowserExamples = function (port) {
-        runServer(port);
-        launchBrowser("examples/browser/index.html", port);
-    };
-
     var generateDocs = function (callback) {
         callback = (callback && utils.isFunction(callback)) ? callback : (function () { });
 
@@ -630,15 +621,6 @@
             "lib/async.js",
             "lib/context.js",
             "lib/service.js",
-            "lib/modularinputs/argument.js",
-            "lib/modularinputs/event.js",
-            "lib/modularinputs/eventwriter.js",
-            "lib/modularinputs/inputdefinition.js",
-            "lib/modularinputs/logger.js",
-            "lib/modularinputs/modularinput.js",
-            "lib/modularinputs/scheme.js",
-            "lib/modularinputs/utils.js",
-            "lib/modularinputs/validationdefinition.js"
         ];
 
         var comments = [];
@@ -655,11 +637,12 @@
             }
 
             ensureDirectoryExists(DOC_DIRECTORY);
-            ensureDirectoryExists(path.join(DOC_DIRECTORY, SDK_VERSION));
-            ensureDirectoryExists(path.join(DOC_DIRECTORY, SDK_VERSION, REFDOC_DIRECTORY));
+
+            // copy static assets directory
+            copyDirectoryRecursiveSync(DOC_DIRECTORY_ASSETS, GENERATED_DOC_ASSETS);
 
             for (var name in data) {
-                var htmlPath = path.join(DOC_DIRECTORY, SDK_VERSION, REFDOC_DIRECTORY, name + ".html");
+                var htmlPath = path.join(DOC_DIRECTORY, name + ".html");
                 fs.writeFileSync(htmlPath, data[name]);
             }
 
@@ -734,10 +717,7 @@
 
         var files = args
             .map(arg => {
-                if (arg.indexOf('modularinputs') >= 0) {
-                    return path.join(TEST_DIRECTORY, 'modularinputs', TEST_PREFIX + arg.split('/')[1] + ".js");
-                }
-                else if (arg.indexOf('service_tests') >= 0) {
+                if (arg.indexOf('service_tests') >= 0) {
                     return path.join(TEST_DIRECTORY, 'service_tests', arg.split('/')[1] + ".js");
                 }
                 else {
@@ -812,7 +792,7 @@
 
     program
         .command('runserver [port]')
-        .description('Run a local server to serve tests and examples.')
+        .description('Run a local server to serve tests.')
         .action(runServer);
 
     program
@@ -843,11 +823,6 @@
         .description('Launch the browser test suite.')
         .action(launchBrowserTests);
 
-    program
-        .command('examples [port]')
-        .description('Launch the browser examples index page.')
-        .action(launchBrowserExamples);
-
     program
         .command('hint')
         .description('Run JSHint on the codebase.')