node-opcua-file-transfer 2.178.0 → 2.180.0

package/source/server/file_type_helpers.ts

@@ -2,30 +2,21 @@
  * @module node-opcua-file-transfer
  */
 
-import { promisify, types } from "util";
-import fsOrig from "fs";
-
-import { assert } from "node-opcua-assert";
+import fsOrig from "node:fs";
+import { promisify, types } from "node:util";
+import type { IAddressSpace, ISessionContext, UAFile, UAFile_Base, UAMethod, UAObjectType } from "node-opcua-address-space";
 import { getContextMaxMessageSize } from "node-opcua-address-space-base";
-import {
-    IAddressSpace,
-    ISessionContext,
-    UAFile,
-    UAFile_Base,
-    UAMethod,
-    UAObjectType
-} from "node-opcua-address-space";
-import { Byte, Int32, UInt32, UInt64 } from "node-opcua-basic-types";
+import { assert } from "node-opcua-assert";
+import type { Byte, Int32, UInt32, UInt64 } from "node-opcua-basic-types";
 import { BinaryStream } from "node-opcua-binary-stream";
+import { DataValue } from "node-opcua-data-value";
 import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
-import { NodeId, NodeIdLike, sameNodeId } from "node-opcua-nodeid";
-import { CallMethodResultOptions } from "node-opcua-service-call";
+import { NodeId, type NodeIdLike, sameNodeId } from "node-opcua-nodeid";
+import type { CallMethodResultOptions } from "node-opcua-service-call";
 import { StatusCodes } from "node-opcua-status-code";
 import { DataType, Variant, VariantArrayType } from "node-opcua-variant";
-import { DataValue } from "node-opcua-data-value";
-
+import type { AbstractFs } from "../common/abstract_fs";
 import { OpenFileMode, OpenFileModeMask } from "../open_mode";
-import { AbstractFs } from "../common/abstract_fs";
 
 const debugLog = make_debugLog("FileType");
 const errorLog = make_errorLog("FileType");
@@ -63,7 +54,7 @@ export interface FileOptions {
     refreshFileContentFunc?: () => Promise<void>;
 }
 
-export interface UAFileType extends UAObjectType, UAFile_Base { }
+export interface UAFileType extends UAObjectType, UAFile_Base {}
 /**
  *
  */
@@ -88,7 +79,7 @@ export class FileTypeData {
         this.refreshFileContentFunc = options.refreshFileContentFunc;
 
         this.filename = options.filename;
-        this.maxSize = options.maxSize!;
+        this.maxSize = options.maxSize ?? 0;
         this.mimeType = options.mimeType || "";
         this.maxChunkSizeBytes = options.maxChunkSize || FileTypeData.maxChunkSize;
 
@@ -102,30 +93,30 @@ export class FileTypeData {
         );
         file.openCount.minimumSamplingInterval = 0; // changes immediately
 
-        const readFileSize =  ():{ size: number, timestamp: Date } => {
+        const readFileSize = (): { size: number; timestamp: Date } => {
             const stat = (this._fs as AbstractFs).statSync(this.filename);
 
             const size = stat.size;
             const timestamp = stat.mtime;
             return { size, timestamp };
-        }
+        };
 
         const data = this;
         file.size.bindVariable(
             {
-                timestamped_get():  DataValue {
+                timestamped_get(): DataValue {
                     try {
                         const { size, timestamp } = readFileSize();
                         data.fileSize = size;
                         return new DataValue({
                             sourceTimestamp: timestamp,
-                            serverTimestamp: (new Date()),
+                            serverTimestamp: new Date(),
                             value: new Variant({ dataType: DataType.UInt64, value: data._fileSize }),
                             statusCode: StatusCodes.Good
                         });
-                    } catch (err) {
+                    } catch (_err) {
                         return new DataValue({
-                            serverTimestamp: (new Date()),
+                            serverTimestamp: new Date(),
                             statusCode: StatusCodes.BadDataUnavailable
                         });
                     }
@@ -175,7 +166,8 @@ export class FileTypeData {
                 }
                 const stat = await promisify(abstractFs.stat)(self.filename);
                 self._fileSize = stat.size;
-                debugLog("original file size ", self.filename, " size = ", self._fileSize);
+                // c8 ignore next
+                doDebug && debugLog("original file size ", self.filename, " size = ", self._fileSize);
             } catch (err) {
                 self._fileSize = 0;
                 if (types.isNativeError(err)) {
@@ -249,8 +241,8 @@ interface FileTypeM {
     $$files: { [key: number]: FileAccessData };
 }
 
-interface AddressSpacePriv extends IAddressSpace, FileTypeM { }
-function _prepare(addressSpace: IAddressSpace, context: ISessionContext): FileTypeM {
+interface AddressSpacePriv extends IAddressSpace, FileTypeM {}
+function _prepare(addressSpace: IAddressSpace): FileTypeM {
     const _context = addressSpace as AddressSpacePriv;
     _context.$$currentFileHandle = _context.$$currentFileHandle ? _context.$$currentFileHandle : 41;
     _context.$$files = _context.$$files || {};
@@ -260,11 +252,11 @@ function _getSessionId(context: ISessionContext) {
     if (!context.session) {
         return new NodeId();
     }
-    assert(context.session && context.session.getSessionId);
+    assert(context.session?.getSessionId);
     return context.session?.getSessionId() || new NodeId();
 }
 function _addFile(addressSpace: IAddressSpace, context: ISessionContext, openMode: OpenFileMode): UInt32 {
-    const _context = _prepare(addressSpace, context);
+    const _context = _prepare(addressSpace);
     _context.$$currentFileHandle++;
     const fileHandle: number = _context.$$currentFileHandle;
     const sessionId = _getSessionId(context);
@@ -282,7 +274,7 @@ function _addFile(addressSpace: IAddressSpace, context: ISessionContext, openMod
 }
 
 function _getFileInfo(addressSpace: IAddressSpace, context: ISessionContext, fileHandle: UInt32): FileAccessData | null {
-    const _context = _prepare(addressSpace, context);
+    const _context = _prepare(addressSpace);
     const _fileInfo = _context.$$files[fileHandle];
     const sessionId = _getSessionId(context);
 
@@ -293,8 +285,8 @@ function _getFileInfo(addressSpace: IAddressSpace, context: ISessionContext, fil
     return _fileInfo;
 }
 
-function _close(addressSpace: IAddressSpace, context: ISessionContext, fileData: FileAccessData) {
-    const _context = _prepare(addressSpace, context);
+function _close(addressSpace: IAddressSpace, fileData: FileAccessData) {
+    const _context = _prepare(addressSpace);
     delete _context.$$files[fileData.handle];
 }
 
@@ -373,7 +365,7 @@ async function _openFile(this: UAMethod, inputArguments: Variant[], context: ISe
 
     const flags = toNodeJSMode(mode);
     if (flags === "?") {
-        errorLog("Invalid mode " + OpenFileMode[mode] + " (" + mode + ")");
+        errorLog(`Invalid mode ${OpenFileMode[mode]} (${mode})`);
         return { statusCode: StatusCodes.BadInvalidArgument };
     }
 
@@ -412,7 +404,6 @@ async function _openFile(this: UAMethod, inputArguments: Variant[], context: ISe
         const fileLength = (await promisify(abstractFs.stat)(filename)).size;
         _fileInfo.size = fileLength;
 
-        // tslint:disable-next-line:no-bitwise
         if ((mode & OpenFileModeMask.AppendBit) === OpenFileModeMask.AppendBit) {
             _fileInfo.position[1] = fileLength;
         }
@@ -429,7 +420,8 @@ async function _openFile(this: UAMethod, inputArguments: Variant[], context: ISe
         return { statusCode: StatusCodes.BadUnexpectedError };
     }
 
-    debugLog("Opening file handle ", fileHandle, "filename: ", fileData.filename, "openCount: ", fileData.openCount);
+    // c8 ignore next
+    doDebug && debugLog("Opening file handle ", fileHandle, "filename: ", fileData.filename, "openCount: ", fileData.openCount);
 
     const callMethodResult = {
         outputArguments: [
@@ -470,10 +462,11 @@ async function _closeFile(this: UAMethod, inputArguments: Variant[], context: IS
 
     const fileData = getFileDataFromContext(context);
 
-    debugLog("Closing file handle ", fileHandle, "filename: ", fileData.filename, "openCount: ", fileData.openCount);
+    // c8 ignore next
+    doDebug && debugLog("Closing file handle ", fileHandle, "filename: ", fileData.filename, "openCount: ", fileData.openCount);
 
     await promisify(abstractFs.close)(_fileInfo.fd);
-    _close(addressSpace, context, _fileInfo);
+    _close(addressSpace, _fileInfo);
     fileData.openCount -= 1;
 
     return {
@@ -513,7 +506,6 @@ async function _readFile(this: UAMethod, inputArguments: Variant[], context: ISe
     if (!_fileInfo) {
         return { statusCode: StatusCodes.BadInvalidState };
     }
-    // tslint:disable-next-line:no-bitwise
     if ((_fileInfo.openMode & OpenFileModeMask.ReadBit) === 0x0) {
         // open mode did not specify Read Flag
         return { statusCode: StatusCodes.BadInvalidState };
@@ -550,7 +542,7 @@ async function _readFile(this: UAMethod, inputArguments: Variant[], context: ISe
     try {
         // note: we do not util.promise here as it has a wierd behavior...
         ret = await new Promise((resolve, reject) =>
-            abstractFs.read(_fileInfo.fd, data, 0, length, _fileInfo.position[1], (err, bytesRead, buff) => {
+            abstractFs.read(_fileInfo.fd, data, 0, length, _fileInfo.position[1], (err, bytesRead, _buff) => {
                 if (err) {
                     return reject(err);
                 }
@@ -585,7 +577,6 @@ async function _writeFile(this: UAMethod, inputArguments: Variant[], context: IS
         return { statusCode: StatusCodes.BadInvalidArgument };
     }
 
-    // tslint:disable-next-line:no-bitwise
     if ((_fileInfo.openMode & OpenFileModeMask.WriteBit) === 0x00) {
         // File has not been open with write mode
         return { statusCode: StatusCodes.BadInvalidState };
@@ -610,9 +601,11 @@ async function _writeFile(this: UAMethod, inputArguments: Variant[], context: IS
         _fileInfo.size = Math.max(_fileInfo.size, _fileInfo.position[1]);
 
         const fileData = getFileDataFromContext(context);
-        debugLog(fileData.fileSize);
+        // c8 ignore next
+        doDebug && debugLog(fileData.fileSize);
         fileData.fileSize = Math.max(fileData.fileSize, _fileInfo.position[1]);
-        debugLog(fileData.fileSize);
+        // c8 ignore next
+        doDebug && debugLog(fileData.fileSize);
     } catch (err) {
         if (types.isNativeError(err)) {
             errorLog("Write error : ", err.message);