@adonisjs/session 6.2.2 → 6.4.0

package/build/adonis-typings/session.d.ts

@@ -231,7 +231,7 @@ declare module '@ioc:Adonis/Addons/Session' {
         /**
          * Load session data from the driver
          */
-        load(): Promise<{
+        load(cookies: Record<string, any>): Promise<{
             session: Record<string, any>;
             flashMessages: Record<string, any> | null;
         }>;

package/build/adonis-typings/tests.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import '@japa/api-client';
+import { InspectOptions } from 'util';
 import { AllowedSessionValues, SessionClientContract } from '@ioc:Adonis/Addons/Session';
 declare module '@japa/api-client' {
     interface ApiRequest {
@@ -24,6 +26,10 @@ declare module '@japa/api-client' {
          * Get session data
          */
         session(): Record<string, any>;
+        /**
+         * Dump session
+         */
+        dumpSession(options?: InspectOptions): this;
         /**
          * Get flash messages set by the server
          */

package/build/config.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @adonisjs/session
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { SessionConfig } from '@ioc:Adonis/Addons/Session';
+/**
+ * Helper to define session config
+ */
+export declare function sessionConfig<Config extends SessionConfig>(config: Config): Config;

package/build/config.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @adonisjs/session
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sessionConfig = void 0;
+/**
+ * Helper to define session config
+ */
+function sessionConfig(config) {
+    return config;
+}
+exports.sessionConfig = sessionConfig;

package/build/src/Bindings/Tests.js

@@ -9,6 +9,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defineTestsBindings = void 0;
+const util_1 = require("util");
 /**
  * Define test bindings
  */
@@ -89,6 +90,14 @@ function defineTestsBindings(ApiRequest, ApiResponse, ApiClient, SessionManager)
         this.ensureHasAssert();
         this.assert.notProperty(this.flashMessages(), name);
     });
+    /**
+     * Dump session to the console
+     */
+    ApiResponse.macro('dumpSession', function (options) {
+        const inspectOptions = { depth: 2, showHidden: false, colors: true, ...options };
+        console.log(`"session"        => ${(0, util_1.inspect)(this.session(), inspectOptions)}`);
+        console.log(`"flashMessages"  => ${(0, util_1.inspect)(this.flashMessages(), inspectOptions)}`);
+    });
     /**
      * Adding hooks directly on the request object moves the hooks to
      * the end of the queue (basically after the globally hooks)
@@ -123,7 +132,7 @@ function defineTestsBindings(ApiRequest, ApiResponse, ApiClient, SessionManager)
          * data
          */
         req.teardown(async (response) => {
-            response.sessionJar = await response.request.sessionClient.load();
+            response.sessionJar = await response.request.sessionClient.load(response.cookies());
             await response.request.sessionClient.forget();
         });
     });

package/build/src/Client/index.d.ts

@@ -34,7 +34,7 @@ export declare class SessionClient extends Store implements SessionClientContrac
     /**
      * Load session from the driver
      */
-    load(): Promise<{
+    load(cookies: Record<string, any>): Promise<{
         session: any;
         flashMessages: any;
     }>;

package/build/src/Client/index.js

@@ -45,8 +45,10 @@ class SessionClient extends Store_1.Store {
     /**
      * Load session from the driver
      */
-    async load() {
-        const contents = await this.driver.read(this.sessionId);
+    async load(cookies) {
+        const sessionIdCookie = cookies[this.config.cookieName];
+        const sessionId = sessionIdCookie ? sessionIdCookie.value : this.sessionId;
+        const contents = await this.driver.read(sessionId);
         const store = new Store_1.Store(contents);
         const flashMessages = store.pull(this.flashMessagesKey, null);
         return {

package/build/src/Session/index.d.ts

@@ -34,6 +34,11 @@ export declare class Session implements SessionContract {
      * A copy of previously set flash messages
      */
     flashMessages: Store;
+    /**
+     * Session id for the current request. It will be different
+     * from the "this.sessionId" when regenerate is called.
+     */
+    private currentSessionId;
     /**
      * A instance of store with values read from the driver. The store
      * in initiated inside the [[initiate]] method
@@ -43,7 +48,7 @@ export declare class Session implements SessionContract {
      * Whether or not to re-generate the session id before comitting
      * session values.
      */
-    private regenerateSessionId;
+    private regeneratedSessionId;
     /**
      * A copy of flash messages. The `input` messages
      * are overwritten when any of the input related

package/build/src/Session/index.js

@@ -46,11 +46,16 @@ class Session {
          * A copy of previously set flash messages
          */
         this.flashMessages = new Store_1.Store({});
+        /**
+         * Session id for the current request. It will be different
+         * from the "this.sessionId" when regenerate is called.
+         */
+        this.currentSessionId = this.sessionId;
         /**
          * Whether or not to re-generate the session id before comitting
          * session values.
          */
-        this.regenerateSessionId = false;
+        this.regeneratedSessionId = false;
         /**
          * A copy of flash messages. The `input` messages
          * are overwritten when any of the input related
@@ -180,7 +185,8 @@ class Session {
      */
     regenerate() {
         this.ctx.logger.trace('explicitly re-generating session id');
-        this.regenerateSessionId = true;
+        this.sessionId = (0, helpers_1.cuid)();
+        this.regeneratedSessionId = true;
     }
     /**
      * Set/update session value
@@ -331,9 +337,8 @@ class Session {
             /**
              * Cleanup old session and re-generate new session
              */
-            if (this.regenerateSessionId) {
-                await this.driver.destroy(this.sessionId);
-                this.sessionId = (0, helpers_1.cuid)();
+            if (this.regeneratedSessionId) {
+                await this.driver.destroy(this.currentSessionId);
             }
             /**
              * Touch the session cookie to keep it alive.

package/build/templates/session.txt

@@ -7,9 +7,9 @@
 
 import Env from '@ioc:Adonis/Core/Env'
 import Application from '@ioc:Adonis/Core/Application'
-import { SessionConfig } from '@ioc:Adonis/Addons/Session'
+import { sessionConfig } from '@adonisjs/session/build/config'
 
-const sessionConfig: SessionConfig = {
+export default sessionConfig({
   /*
   |--------------------------------------------------------------------------
   | Enable/Disable sessions
@@ -113,6 +113,4 @@ const sessionConfig: SessionConfig = {
   |
   */
   redisConnection: 'local',
-}
-
-export default sessionConfig
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/session",
-  "version": "6.2.2",
+  "version": "6.4.0",
   "description": "Session provider for AdonisJS",
   "typings": "./build/adonis-typings/index.d.ts",
   "main": "build/providers/SessionProvider.js",
@@ -8,44 +8,47 @@
     "build/adonis-typings",
     "build/providers",
     "build/src",
+    "build/config.js",
+    "build/config.d.ts",
     "build/templates",
     "build/instructions.md"
   ],
   "dependencies": {
     "@poppinss/utils": "^4.0.4",
-    "fs-extra": "^10.0.1"
+    "fs-extra": "^10.1.0"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^5.5.0"
+    "@adonisjs/core": "^5.8.0"
   },
   "devDependencies": {
-    "@adonisjs/core": "^5.7.3",
+    "@adonisjs/core": "^5.8.2",
     "@adonisjs/mrm-preset": "^5.0.3",
-    "@adonisjs/redis": "^7.2.0",
+    "@adonisjs/redis": "^7.3.0",
     "@adonisjs/require-ts": "^2.0.11",
     "@japa/assert": "^1.3.4",
     "@japa/preset-adonis": "^1.0.15",
     "@japa/run-failed-tests": "^1.0.7",
-    "@japa/runner": "^2.0.7",
+    "@japa/runner": "^2.0.8",
     "@japa/spec-reporter": "^1.1.12",
     "@poppinss/dev-utils": "^2.0.3",
-    "@types/node": "^17.0.23",
+    "@types/node": "^17.0.34",
     "@types/supertest": "^2.0.12",
     "commitizen": "^4.2.4",
     "copyfiles": "^2.4.1",
     "cz-conventional-changelog": "^3.3.0",
     "del-cli": "^4.0.1",
-    "eslint": "^8.13.0",
+    "eslint": "^8.15.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "github-label-sync": "^2.2.0",
-    "husky": "^7.0.4",
+    "husky": "^8.0.1",
     "mrm": "^4.0.0",
     "np": "^7.6.1",
     "prettier": "^2.6.2",
-    "supertest": "^6.2.2",
-    "typescript": "^4.6.3"
+    "set-cookie-parser": "^2.4.8",
+    "supertest": "^6.2.3",
+    "typescript": "^4.6.4"
   },
   "scripts": {
     "mrm": "mrm --preset=@adonisjs/mrm-preset",